home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 June / EnigmA AMIGA RUN 19 (1997)(G.R. Edizioni)(IT)[!][issue 1997-06][EAR-CD III].iso / recent1 / clipper.lha / Clipper v2.27 / Clipper.doc < prev    next >
Text File  |  1997-05-22  |  10KB  |  354 lines
  1. Clipper v2.27
  2.  
  3. Contents
  4. --------
  5.  
  6.  If you are upgrading from v2.24 then please read 'New features' first.
  7.  
  8.  1 What is Clipper?
  9.  2 Installation
  10.  
  11.     2.1 Minimum specs
  12.  
  13.  3 The interface
  14.  
  15.     3.1 Control panel
  16.  
  17.         3.1.1 Title bar
  18.         3.1.2 Icon/bob bank gadgets
  19.         3.1.3 File gadgets
  20.         3.1.4 IFF gadgets
  21.         3.1.5 Autoclip gadgets
  22.         3.1.6 Hotspot gadgets
  23.         3.1.7 Tool gadgets
  24.         3.1.8 Messages and requesters
  25.  
  26.     3.2 ILBM display
  27.     3.3 Icon/bob display
  28.     3.4 Selecting points and areas
  29.  
  30.  4 Bugs
  31.  5 New features
  32.  6 About the author
  33.  7 Legal stuff
  34.  
  35.  
  36. 1 What is Clipper?
  37. ------------------
  38.  
  39. Clipper is a program designed to make it easier for AMOS programmers to
  40. create icons and bobs. It allows you to 'clip' them from an ILBM screen
  41. and also provides some useful facilities for managing icon/bob banks.
  42.  
  43. I know AMOS comes with an icon/bob editor but I find it's better to
  44. create icons/bobs in a paint package such as DPaint and then clip them
  45. out afterwards. Since I continually alter image banks during game
  46. development I needed a utility to speed up the clipping process and so
  47. Clipper was born!
  48.  
  49.  
  50. 2 Installation
  51. --------------
  52.  
  53. Clipper is provided as a compiled program to be used within the AMOS
  54. environment. To install it simply copy the Clipper program and docs to
  55. your hard disk or AMOS system disk.
  56.  
  57.  
  58. 2.1 Minimum specs
  59. -----------------
  60.  
  61. Clipper was written on an A1200 with a 4 Meg Hawk memory card.
  62.  
  63. It runs OK on a standard A500 but it will slow down when displaying the
  64. magnified view while clipping, etc.
  65.  
  66.  
  67. 3 The interface
  68. ---------------
  69.  
  70. Clipper is composed of three parts;
  71.  
  72.     an intuition style control panel,
  73.     an IFF screen display and
  74.     an icon/bob display.
  75.  
  76.  
  77. 3.1 Control panel
  78. -----------------
  79.  
  80. The control panel gadgets are arranged into groups;
  81.  
  82.     Title bar,
  83.     Icon/bob bank gadgets,
  84.     File gadgets,
  85.     IFF gadgets,
  86.     Autoclip gadgets,
  87.     Hotspot gadgets and
  88.     Tool gadgets.
  89.  
  90.  
  91. 3.1.1 Title bar
  92. ---------------
  93.  
  94.  Hotkeys are shown in [] if available.
  95.  
  96.  Drag bar     - This lets you drag the control panel. It also shows the total
  97.                 number of icons/bobs in the selected bank, the selected
  98.                 icon/bob's number, size and colour depth and the amount of
  99.                 free chip memory. Messages and requests are also displayed in
  100.                 the title bar.
  101.  
  102.  [I] Info     - Displays copyright information.
  103.  
  104.  [Q] Quit     - Quits Clipper. You will be asked to confirm that you really
  105.                 want to quit.
  106.  
  107.  
  108. 3.1.2 Icon/bob bank gadgets
  109. ---------------------------
  110.  
  111.  Hotkeys are shown in [] if available.
  112.  
  113.  [down] |<  - Moves to the first icon/bob in the current bank.
  114.  
  115.  [left] <<  - Move back through the current bank. Left click to move 1,
  116.               right click to move 10.
  117.  
  118.  ##         - This string gadget shows the number of the currently selected
  119.               icon/bob.
  120.  
  121.  [right] >> - Move forward through the current bank. Left click to move 1,
  122.               right click to move 10.
  123.  
  124.  [up] >|    - Moves to the last icon/bob in the current bank.
  125.  
  126.  [I] Ins    - Inserts a blank space between the current and previous
  127.               icon/bob.
  128.  
  129.  [D] Del    - Deletes the current icon/bob.
  130.  
  131.  
  132. 3.1.3 File gadgets
  133. ------------------
  134.  
  135.  Hotkeys are shown in [] if available.
  136.  
  137.  [L] Load  - Loads an icon or bob bank into memory. Note that it
  138.              automatically loads the file into the correct bank.
  139.  
  140.  [S] Save  - Saves the currently selected bank.
  141.  
  142.  [M] Merge - Allows you to append a bank with a bank saved to disk. Note
  143.              that it will be appended to the same bank it was saved from.
  144.  
  145.  [E] Erase - Erases the currently selected bank. You will be asked to
  146.              confirm this before it is erased.
  147.  
  148.  [W] Swap  - Swaps between the icon and bob banks.
  149.  
  150.  
  151. 3.1.4 IFF gadgets
  152. -----------------
  153.  
  154.  Hotkeys are shown in [] if available.
  155.  
  156.  [F] Load IFF - Loads an IFF screen. Legal screen modes are;
  157.  
  158.                 Pal     lowres              320x256
  159.                         lowres interlaced   320x512
  160.                         hires               640x256
  161.                         hires interlaced    640x512
  162.  
  163.                 Ntsc    lowres              320x200
  164.                         lowres interlaced   320x400
  165.                         hires               640x200
  166.                         hires interlaced    640x400
  167.  
  168.  [O] Show     - Hides the control panel and icon/bob display so the current
  169.                 screen can be viewed. Press either mouse button to continue.
  170.  
  171.  
  172. 3.1.5 Autoclip gadgets
  173. ----------------------
  174.  
  175.  Hotkeys are shown in [] if available.
  176.  
  177.  [T] Start  - This sets where autoclip starts. Clicking on this gadget allows
  178.               you to select the start by hand, alternatively it can be set
  179.               using the string gadgets.
  180.  
  181.  [Z] Size   - This sets the size of the blocks to be cut.
  182.  
  183.  [G] Gap    - This sets the size of any space that may be between the blocks.
  184.  
  185.  [B] Blocks - This sets the number of blocks to be cut. To specify this
  186.               by hand select the top left block and then the bottom right
  187.               block of the grid of blocks to be cut. Note that the Size and
  188.               Gap must be set first.
  189.  
  190.  
  191. 3.1.6 Hotspot gadgets
  192. ---------------------
  193.  
  194.  Hotkeys are shown in [] if available.
  195.  
  196.  [H] Hotspot - This sets the hotspot of the currently selected bob.
  197.  
  198.  The hotspot gadgets on the third row set the default hotspot position
  199.  for newly created bobs...
  200.  
  201.  Cross hair  - This makes the values of the hotspot gadget the default
  202.                hotspot position for new bobs.
  203.  
  204.  Presets     - Clicking on one of these gadgets will make that position
  205.                the default hotspot position for new bobs. Right clicking
  206.                on one of these gadgets will also set the currently
  207.                selected bob's hotspot to the specified position.
  208.  
  209.  
  210. 3.1.7 Tool gadgets
  211. ------------------
  212.  
  213.  Hotkeys are shown in [] if available.
  214.  
  215.  Sound          - Toggles sound effects. It is off by default.
  216.  
  217.  [1] Cut        - Clip an icon/bob by hand.
  218.  
  219.  [2] Autoclip   - Automates clipping icons/bobs. The autocut gadgets must
  220.                   be setup as desired first. The new icons/bobs will be
  221.                   placed starting at the currently selected icon/bob. If
  222.                   autocutting will overwrite icons/bobs currently in the bank
  223.                   you will be asked if you wish to continue.
  224.  
  225.  [3] Point      - Lets the user clip an icon/bob by clicking on it. For this
  226.                   to work the icon/bob must be surrounded by colour 0.
  227.  
  228.  [4] Palette    - Loads the screen's palette into the currently selected bank.
  229.                   This is useful if you change the colours used in a screen
  230.                   but don't want to recut the icons/bobs you have originally
  231.                   clipped from it.
  232.  
  233.  [5] Horiz flip - Flip the currently selected icon/bob along its horizontal
  234.                   axis.
  235.  
  236.  [6] Vert flip  - Flip the currently selected icon/bob along its vertical
  237.                   axis.
  238.  
  239.  [7] Compress   - Attempts to remove any blank space around the currently
  240.                   selected icon/bob.
  241.  
  242.  
  243. 3.1.8 Messages and requesters
  244. -----------------------------
  245.  
  246. Sometimes Clipper will need to inform you that an operation has failed or
  247. ask you to confirm your choice, such as when you quit. These messages
  248. will be displayed in the title bar of the control panel. If a reply is
  249. needed you will be prompted to press either the left or right mouse
  250. button depending on the options presented.
  251.  
  252.  
  253. 3.2 ILBM display
  254. ----------------
  255.  
  256. The ILBM display shows the currently loaded screen from which icons/bobs
  257. are to be clipped.
  258.  
  259.  
  260. 3.3 Icon/bob display
  261. --------------------
  262.  
  263. The icon/bob display shows the currently selected icon/bob if there is
  264. one. If the display shows a bob it will indicate the position of its
  265. hotspot with a flashing pixel.
  266.  
  267.  
  268. 3.4 Selecting points and areas
  269. ------------------------------
  270.  
  271. When you clip an icon/bob or set a bob's hotspot, etc you will need to
  272. define an area or point in the ILBM display or icon/bob display. When
  273. this is needed the control panel will disappear and a cross hair will be
  274. shown as well as a magnified view of the area around it. The cross hair
  275. can be positioned with the mouse or 'nudged' using the cursor keys. The
  276. zoomed view can be toggled on/off with the spacebar.
  277.  
  278. To select a point place the cross hair over the desired point and left
  279. click the mouse or press the return key.
  280.  
  281. To define an area select one of its corners and then select the
  282. opposite corner.
  283.  
  284. The operation can be cancelled at any time by clicking the right mouse
  285. button.
  286.  
  287.  
  288. 4 Bugs
  289. ------
  290.  
  291.  * When clipping from hires and/or laced screens the crosshair will move
  292.    in lowres coords. This is caused by a bug in the way AMOS reads mouse
  293.    positions.
  294.  
  295.  
  296. 5 New features
  297. --------------
  298.  
  299. New features added in Clipper v2.27;
  300.  
  301.  * Hotkeys for most buttons. Note: for buttons which respond differently
  302.    to left and right mouse clicks, pressing a hotkey simulates a left click.
  303.  
  304.  * The zoomed view shown when clipping, setting a hotspot, etc can now be
  305.    toggled on/off with the spacebar.
  306.  
  307.  * Tabbing and shift tabbing between string gadgets is now supported.
  308.  
  309.  * A nice colour change 8-).
  310.  
  311.  
  312. 6 About the author
  313. ------------------
  314.  
  315. Hi!
  316.  
  317. I'm the CD Editor for MacFormat magazine (don't worry I still like Amigas!)
  318. and I've been dabbling in computer programming ever since I got my first
  319. 8-bit machine, an Amstrad CPC 464.
  320.  
  321. Clipper was the first Amiga program I finished, or at least got to a stage
  322. where it's safe for people to use (no major bugs!) I've already
  323. used it to create several games which I will be releasing soon. Because I've
  324. recently switched to programming in AmigaE these will be my last AMOS
  325. programs. I hope Clipper will be useful to all you AMOS developers out there.
  326.  
  327. - Brian Smith.  ]8>
  328.  
  329. I can be reached at:
  330.  
  331.   Flat 5A
  332.   36 Grosvenor Place
  333.   Bath BA1 6BA
  334.   England
  335.  
  336.   bsmith@futurenet.co.uk
  337.  
  338.   106662.1610@compuserve.com
  339.  
  340.  
  341. 7 Legal stuff
  342. -------------
  343.  
  344. Clipper v2.27 Copyright 1996 Brian N Smith. All rights reserved.
  345.  
  346. Clipper may be freely distributed as long as it is accompanied by its
  347. doc files.
  348.  
  349. This software is provided as is, the author can not be held responsible
  350. for any damage caused to hardware or software through its use.
  351.  
  352. This program is progenyware. If you use it to create a game then please
  353. send me a copy.
  354.